Skip to content

Refactor docs so quick start instructions are for creating an AKS man… #5625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor docs so quick start instructions are for creating an AKS man… #5625

wants to merge 1 commit into from
+122 −1

Conversation

alimaazamat
Copy link
Contributor

@alimaazamat alimaazamat commented May 8, 2025 •
edited
Loading

Quickstart for users should be creating a managed cluster: an aks management cluster with workload identity.

What type of PR is this?
/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #4768

Special notes for your reviewer:

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests
  • cherry-pick candidate

Release note:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 8, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign neolit123 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 8, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @alimaazamat. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 8, 2025
@alimaazamat alimaazamat force-pushed the workload-id-with-aks-docs branch from 762e75c to 77f8162 Compare May 8, 2025 22:21
@codecov Codecov
Copy link

codecov bot commented May 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.27%. Comparing base (66244df) to head (b09fdbf).
Report is 23 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5625      +/-   ##
==========================================
- Coverage   53.28%   53.27%   -0.01%     
==========================================
  Files         272      272              
  Lines       29521    29522       +1     
==========================================
  Hits        15729    15729              
- Misses      12977    12978       +1     
  Partials      815      815

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alimaazamat alimaazamat force-pushed the workload-id-with-aks-docs branch from 77f8162 to 8b3b323 Compare May 9, 2025 22:17
@nawazkh
Copy link
Member

nawazkh commented May 9, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 9, 2025
@alimaazamat alimaazamat force-pushed the workload-id-with-aks-docs branch 2 times, most recently from 9ad5653 to 67f8a6f Compare May 12, 2025 22:04
mboersma
mboersma reviewed May 14, 2025
View reviewed changes
docs/book/src/getting-started-with-aks.md
```
## Building your First Cluster

To create a workload cluster, follow the [Cluster API Quick Start: Create your first workload cluster](https://cluster-api.sigs.k8s.io/user/quick-start.html) for detailed instructions. Ensure you select the "Azure" tabs for Azure-specific guidance.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like we're repeating the same instructions from line 110 here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is highlighting a different part of the Quick Start (which I can appreciate-I am partial to overexplaining)

Copy link
Contributor Author

@alimaazamat alimaazamat May 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same instructions but different sections. So I did Cluster API Quick Start: <"section"> to point to what specific section of the Cluster API Quick Start documentation is relevant.
Let me know how this sounds, I was thinking of merging this information in one step but in between you need to annotate the capz-manager service account and that isn't in the Cluster API Quick Start docs since that is specific to workload identity.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's an in between step I wouldn't merge them for newer users. It's easier to follow that way.

@mbrow137
Copy link
Contributor

Matt hit on a lot of the suggestions I had to offer. So outside of those, the only other thing I can suggest is adding potential error handling could be helpful. Otherwise, looks good to me! :) Thank you again for this!

@alimaazamat alimaazamat force-pushed the workload-id-with-aks-docs branch from 27b44e5 to b09fdbf Compare May 21, 2025 19:54
@mbrow137
Copy link
Contributor

\lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mboersma mboersma mboersma left review comments

@mbrow137 mbrow137 mbrow137 left review comments

@willie-yao willie-yao Awaiting requested review from willie-yao

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
CAPZ Planning
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to run management server using AKS with workload identity
5 participants
@alimaazamat @k8s-ci-robot @nawazkh @mbrow137 @mboersma